/*
   Copyright (c) 2009-
   Winnem Consulting
   Kirkealleen 58
   3470 Slemmestad
   Norway


   All rights reserved.

   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions are
   met:

 * Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
 * The end-user documentation included with the redistribution, if
   any, must include the following acknowledgement:
 * Neither the name of "Winnem Consulting" nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.

   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
   IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
   TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
   PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
   OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
   PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
   PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.winnemconsulting.javatoactionscript.util
{

	/**
	 * Actionscript equivalent to java interface
	 * @author Geirr Winnem
	 * @see http://java.sun.com/j2se/1.4.2/docs/api/java/util/Comparator.html
	 */
	public interface Comparator
	{
		/**
		 * Compares its two arguments for order.
		 * @param objectA Object
		 * @param objectB Object
		 * @return Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.
		 */
		function compare(objectA:Object, objectB:Object):int;

		/**
		 * Indicates whether some other object is equal to this Comparator.
		 * @param objectA
		 * @return true only if the specified object is also a comparator and it imposes the same ordering as this comparator
		 */
		function equals(objectA:Object):Boolean;
	}
}